<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>SystemSharp: DocumentationGenerator.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">SystemSharp
   &#160;<span id="projectnumber">0.3</span>
   </div>
   <div id="projectbrief">A system-level modeling framework for designing real-time embedded systems</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_documentation_generator_8cs_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Events</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">DocumentationGenerator.cs</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_documentation_generator_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">using</span> System;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">using</span> System.Collections.Generic;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">using</span> System.IO;</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">using</span> System.Linq;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">using</span> System.Text;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">using</span> Microsoft.Experimental.IO;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">using</span> SystemSharp.Components;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">using</span> SystemSharp.Meta;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespace_system_sharp_1_1_synthesis_1_1_doc_gen.html">   29</a></span>&#160;<span class="keyword">namespace </span>SystemSharp.Synthesis.DocGen</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html">   34</a></span>&#160;    <span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html">DocumentationGenerator</a>:</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;        <a class="code" href="interface_system_sharp_1_1_synthesis_1_1_i_code_generator.html">ICodeGenerator</a></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    {</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a28db443ffc2fb082a488986df6fef72d">   37</a></span>&#160;        <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a28db443ffc2fb082a488986df6fef72d">GetComponentID</a>(<a class="code" href="interface_system_sharp_1_1_meta_1_1_i_component_descriptor.html">IComponentDescriptor</a> cdesc)</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;            <span class="keywordflow">return</span> cdesc.Name;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;        }</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a5b5506a36093928b58060e0f05e44529">   42</a></span>&#160;        <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a5b5506a36093928b58060e0f05e44529">Initialize</a>(<a class="code" href="interface_system_sharp_1_1_synthesis_1_1_i_project.html">IProject</a> project, <a class="code" href="class_system_sharp_1_1_components_1_1_design_context.html">DesignContext</a> context)</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        {</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        }</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a4d20ac6043534da087cd515dd0b0b2b1">   46</a></span>&#160;        <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a4d20ac6043534da087cd515dd0b0b2b1">GenerateComponent</a>(<a class="code" href="interface_system_sharp_1_1_synthesis_1_1_i_project.html">IProject</a> project, <a class="code" href="interface_system_sharp_1_1_meta_1_1_i_component_descriptor.html">IComponentDescriptor</a> cdesc)</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        {</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;            var docproj = project as <a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_project.html">DocumentationProject</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;            <span class="keywordflow">if</span> (docproj == null)</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentException(<span class="stringliteral">&quot;Expected a documentation project&quot;</span>);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;            var docs = ((<a class="code" href="class_system_sharp_1_1_meta_1_1_descriptor_base.html">DescriptorBase</a>)cdesc).GetDocumentation();</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            <span class="keywordtype">string</span> prefix = cdesc.GetFullName().Replace(<span class="stringliteral">&quot;.&quot;</span>, <span class="stringliteral">&quot;/&quot;</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;            <span class="keywordflow">foreach</span> (var doc <span class="keywordflow">in</span> docs.Documents)</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;            {</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;                <span class="keywordtype">string</span> legalName = doc.Name.Replace(<span class="charliteral">&#39;&lt;&#39;</span>, <span class="charliteral">&#39;_&#39;</span>).Replace(<span class="charliteral">&#39;&gt;&#39;</span>, <span class="charliteral">&#39;_&#39;</span>);</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;                <span class="keywordtype">string</span> name = prefix + <span class="stringliteral">&quot;/&quot;</span> + legalName;</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;                <span class="keywordtype">string</span> path = docproj.AddFile(name);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;                var <a class="code" href="namespace_system_sharp_1_1_components.html#a00364849637999f74d55598b116750c8abc7b36fe4d2924e49800d9b3dc4a325c">fs</a> = LongPathFile.Open(path, FileMode.Create, FileAccess.Write);</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                var wr = <span class="keyword">new</span> StreamWriter(fs);</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;                wr.WriteLine(doc.Content.ToString());</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;                wr.Close();</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;            }</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        }</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#aa8f91f0719af677282f59930a07a0d00">   65</a></span>&#160;        <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#aa8f91f0719af677282f59930a07a0d00">GeneratePackage</a>(<a class="code" href="interface_system_sharp_1_1_synthesis_1_1_i_project.html">IProject</a> project, <a class="code" href="class_system_sharp_1_1_meta_1_1_package_descriptor.html">PackageDescriptor</a> pdesc)</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        {</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        }</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    }</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;}</div>
<div class="ttc" id="class_system_sharp_1_1_meta_1_1_package_descriptor_html"><div class="ttname"><a href="class_system_sharp_1_1_meta_1_1_package_descriptor.html">SystemSharp.Meta.PackageDescriptor</a></div><div class="ttdoc">Describes a package. </div><div class="ttdef"><b>Definition:</b> <a href="_components_reflection_8cs_source.html#l01969">ComponentsReflection.cs:1969</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_project_html"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_project.html">SystemSharp.Synthesis.DocGen.DocumentationProject</a></div><div class="ttdoc">A documentation project gathers a collection of documentation files. </div><div class="ttdef"><b>Definition:</b> <a href="_documentation_project_8cs_source.html#l00031">DocumentationProject.cs:31</a></div></div>
<div class="ttc" id="interface_system_sharp_1_1_synthesis_1_1_i_code_generator_html"><div class="ttname"><a href="interface_system_sharp_1_1_synthesis_1_1_i_code_generator.html">SystemSharp.Synthesis.ICodeGenerator</a></div><div class="ttdoc">Source code generator interface. </div><div class="ttdef"><b>Definition:</b> <a href="_synthesis_8cs_source.html#l00118">Synthesis.cs:118</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator_html_a5b5506a36093928b58060e0f05e44529"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a5b5506a36093928b58060e0f05e44529">SystemSharp.Synthesis.DocGen.DocumentationGenerator.Initialize</a></div><div class="ttdeci">void Initialize(IProject project, DesignContext context)</div><div class="ttdoc">Notifies the generator about the begin of a new code generation task. </div><div class="ttdef"><b>Definition:</b> <a href="_documentation_generator_8cs_source.html#l00042">DocumentationGenerator.cs:42</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_components_1_1_design_context_html"><div class="ttname"><a href="class_system_sharp_1_1_components_1_1_design_context.html">SystemSharp.Components.DesignContext</a></div><div class="ttdoc">This class encapsulates the simulation context. Each design has an associated simulation context...</div><div class="ttdef"><b>Definition:</b> <a href="_design_context_8cs_source.html#l00047">DesignContext.cs:47</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator_html_a28db443ffc2fb082a488986df6fef72d"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a28db443ffc2fb082a488986df6fef72d">SystemSharp.Synthesis.DocGen.DocumentationGenerator.GetComponentID</a></div><div class="ttdeci">string GetComponentID(IComponentDescriptor cdesc)</div><div class="ttdoc">Returns the identifier which the code generator will use to identify the generated component within t...</div><div class="ttdef"><b>Definition:</b> <a href="_documentation_generator_8cs_source.html#l00037">DocumentationGenerator.cs:37</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator_html_aa8f91f0719af677282f59930a07a0d00"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#aa8f91f0719af677282f59930a07a0d00">SystemSharp.Synthesis.DocGen.DocumentationGenerator.GeneratePackage</a></div><div class="ttdeci">void GeneratePackage(IProject project, PackageDescriptor pdesc)</div><div class="ttdoc">Instructs the generator to generate code for a specific package. </div><div class="ttdef"><b>Definition:</b> <a href="_documentation_generator_8cs_source.html#l00065">DocumentationGenerator.cs:65</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator_html"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html">SystemSharp.Synthesis.DocGen.DocumentationGenerator</a></div><div class="ttdoc">Generates all documentation which is part of a design. </div><div class="ttdef"><b>Definition:</b> <a href="_documentation_generator_8cs_source.html#l00034">DocumentationGenerator.cs:34</a></div></div>
<div class="ttc" id="interface_system_sharp_1_1_synthesis_1_1_i_project_html"><div class="ttname"><a href="interface_system_sharp_1_1_synthesis_1_1_i_project.html">SystemSharp.Synthesis.IProject</a></div><div class="ttdoc">Interface for project generators. </div><div class="ttdef"><b>Definition:</b> <a href="_synthesis_8cs_source.html#l00045">Synthesis.cs:45</a></div></div>
<div class="ttc" id="interface_system_sharp_1_1_meta_1_1_i_component_descriptor_html"><div class="ttname"><a href="interface_system_sharp_1_1_meta_1_1_i_component_descriptor.html">SystemSharp.Meta.IComponentDescriptor</a></div><div class="ttdoc">Base interface for component descriptors. </div><div class="ttdef"><b>Definition:</b> <a href="_components_reflection_8cs_source.html#l01923">ComponentsReflection.cs:1923</a></div></div>
<div class="ttc" id="namespace_system_sharp_1_1_components_html_a00364849637999f74d55598b116750c8abc7b36fe4d2924e49800d9b3dc4a325c"><div class="ttname"><a href="namespace_system_sharp_1_1_components.html#a00364849637999f74d55598b116750c8abc7b36fe4d2924e49800d9b3dc4a325c">SystemSharp.Components.fs</a></div><div class="ttdoc">femto-seconds </div></div>
<div class="ttc" id="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator_html_a4d20ac6043534da087cd515dd0b0b2b1"><div class="ttname"><a href="class_system_sharp_1_1_synthesis_1_1_doc_gen_1_1_documentation_generator.html#a4d20ac6043534da087cd515dd0b0b2b1">SystemSharp.Synthesis.DocGen.DocumentationGenerator.GenerateComponent</a></div><div class="ttdeci">void GenerateComponent(IProject project, IComponentDescriptor cdesc)</div><div class="ttdoc">Instructs the generator to generate code for a specific component. </div><div class="ttdef"><b>Definition:</b> <a href="_documentation_generator_8cs_source.html#l00046">DocumentationGenerator.cs:46</a></div></div>
<div class="ttc" id="class_system_sharp_1_1_meta_1_1_descriptor_base_html"><div class="ttname"><a href="class_system_sharp_1_1_meta_1_1_descriptor_base.html">SystemSharp.Meta.DescriptorBase</a></div><div class="ttdoc">Base implementation of any descriptor. </div><div class="ttdef"><b>Definition:</b> <a href="_components_reflection_8cs_source.html#l00362">ComponentsReflection.cs:362</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_bb5e995590685548b7e11478911ee7c3.html">SystemSharp-Google-SVN</a></li><li class="navelem"><a class="el" href="dir_8deefa4467a62b572b52d238d562b104.html">SystemSharp</a></li><li class="navelem"><a class="el" href="dir_0e5a72156f8560bbc472a395da2569d6.html">SystemSharp</a></li><li class="navelem"><a class="el" href="dir_9d3c30b4336bd92c64ccf0aeee487ace.html">SystemSharp</a></li><li class="navelem"><a class="el" href="dir_c7fae1b46a76b74206568f11430f4459.html">Synthesis</a></li><li class="navelem"><a class="el" href="dir_e1178ade1755e1c745f1bcffa11d6639.html">DocGen</a></li><li class="navelem"><a class="el" href="_documentation_generator_8cs.html">DocumentationGenerator.cs</a></li>
    <li class="footer">Generated on Thu Dec 26 2013 14:21:38 for SystemSharp by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
